<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Dimble's Playground » \RPermissionDataProvider</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Dimble's Playground</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Auth.html"><i class="icon-folder-open"></i> Auth</a></li>
<li><a href="../packages/Database.html"><i class="icon-folder-open"></i> Database</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Infraestructure.html"><i class="icon-folder-open"></i> Infraestructure</a></li>
<li><a href="../packages/Rights.html"><i class="icon-folder-open"></i> Rights</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">418</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<div class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Constructs the data provider."><span class="description">Constructs the data provider.</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_getRoles" title="getRoles() :: "><span class="description">getRoles()
        </span><pre>getRoles()</pre></a></li>
<li class="method public "><a href="#method_init" title="init() :: Initializes the data provider."><span class="description">Initializes the data provider.</span><pre>init()</pre></a></li>
</ul>
</li>
<li class="nav-header protected">» Protected
                    <ul>
<li class="method protected "><a href="#method_calculateTotalItemCount" title="calculateTotalItemCount() :: Calculates the total number of data items."><span class="description">Calculates the total number of data items.</span><pre>calculateTotalItemCount()</pre></a></li>
<li class="method protected "><a href="#method_fetchData" title="fetchData() :: Fetches the data from the persistent data storage."><span class="description">Fetches the data from the persistent data storage.</span><pre>fetchData()</pre></a></li>
<li class="method protected "><a href="#method_fetchKeys" title="fetchKeys() :: Fetches the data item keys from the persistent data storage."><span class="description">Fetches the data item keys from the persistent data storage.</span><pre>fetchKeys()</pre></a></li>
<li class="method protected "><a href="#method_generateData" title="generateData() :: Generates the data for the data provider."><span class="description">Generates the data for the data provider.</span><pre>generateData()</pre></a></li>
<li class="method protected "><a href="#method_setItems" title="setItems() :: Sets the items property."><span class="description">Sets the items property.</span><pre>setItems()</pre></a></li>
<li class="method protected "><a href="#method_setParents" title="setParents() :: Sets the parents property."><span class="description">Sets the parents property.</span><pre>setParents()</pre></a></li>
<li class="method protected "><a href="#method_setPermissions" title="setPermissions() :: Sets the permissions property."><span class="description">Sets the permissions property.</span><pre>setPermissions()</pre></a></li>
<li class="method protected "><a href="#method_setRoles" title="setRoles() :: Sets the roles property."><span class="description">Sets the roles property.</span><pre>setRoles()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i title="Properties" class="icon-custom icon-property"></i> Properties
                    <ul><li class="property public "><a href="#property_displayParentType" title="$displayParentType() :: "><span class="description"></span><pre>$displayParentType</pre></a></li></ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="property private "><a href="#property__authorizer" title="$_authorizer() :: "><span class="description"></span><pre>$_authorizer</pre></a></li>
<li class="property private "><a href="#property__items" title="$_items() :: "><span class="description"></span><pre>$_items</pre></a></li>
<li class="property private "><a href="#property__parents" title="$_parents() :: "><span class="description"></span><pre>$_parents</pre></a></li>
<li class="property private "><a href="#property__permissions" title="$_permissions() :: "><span class="description"></span><pre>$_permissions</pre></a></li>
<li class="property private "><a href="#property__roles" title="$_roles() :: "><span class="description"></span><pre>$_roles</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\RPermissionDataProvider"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/RPermissionDataProvider.html">RPermissionDataProvider</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Rights permission data provider class file.</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:cniska@live.com">Christoffer Niska</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright &amp;copy; 2010 Christoffer Niska</td>
</tr>
<tr>
<th>since</th>
<td>0.9.11</td>
</tr>
<tr>
<th>package</th>
<td><a href="../packages/Rights.data%20providers.html">Rights\data providers</a></td>
</tr>
</table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Constructs the data provider.</h2>
<pre>__construct(string $id, array $config<code> = array()</code>) : <a href="permissionDataProvider.html">\permissionDataProvider</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id</h4>
<code>string</code><p>the data provider identifier.</p></div>
<div class="subelement argument">
<h4>$config</h4>
<code>array</code><p>configuration (name=>value) to be applied as the initial property values of this class.</p></div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="permissionDataProvider.html">\permissionDataProvider</a></code></div>
</div></div>
</div>
<a id="method_getRoles"></a><div class="element clickable method public method_getRoles" data-toggle="collapse" data-target=".method_getRoles .collapse" title="public">
<h2>getRoles()
        </h2>
<pre>getRoles() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>the roles.</div>
</div></div>
</div>
<a id="method_init"></a><div class="element clickable method public method_init" data-toggle="collapse" data-target=".method_init .collapse" title="public">
<h2>Initializes the data provider.</h2>
<pre>init() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_calculateTotalItemCount"></a><div class="element clickable method protected method_calculateTotalItemCount" data-toggle="collapse" data-target=".method_calculateTotalItemCount .collapse" title="protected">
<h2>Calculates the total number of data items.</h2>
<pre>calculateTotalItemCount() : integer</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>integer</code>the total number of data items.</div>
</div></div>
</div>
<a id="method_fetchData"></a><div class="element clickable method protected method_fetchData" data-toggle="collapse" data-target=".method_fetchData .collapse" title="protected">
<h2>Fetches the data from the persistent data storage.</h2>
<pre>fetchData() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of data items</div>
</div></div>
</div>
<a id="method_fetchKeys"></a><div class="element clickable method protected method_fetchKeys" data-toggle="collapse" data-target=".method_fetchKeys .collapse" title="protected">
<h2>Fetches the data item keys from the persistent data storage.</h2>
<pre>fetchKeys() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of data item keys.</div>
</div></div>
</div>
<a id="method_generateData"></a><div class="element clickable method protected method_generateData" data-toggle="collapse" data-target=".method_generateData .collapse" title="protected">
<h2>Generates the data for the data provider.</h2>
<pre>generateData() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_setItems"></a><div class="element clickable method protected method_setItems" data-toggle="collapse" data-target=".method_setItems .collapse" title="protected">
<h2>Sets the items property.</h2>
<pre>setItems() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_setParents"></a><div class="element clickable method protected method_setParents" data-toggle="collapse" data-target=".method_setParents .collapse" title="protected">
<h2>Sets the parents property.</h2>
<pre>setParents() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_setPermissions"></a><div class="element clickable method protected method_setPermissions" data-toggle="collapse" data-target=".method_setPermissions .collapse" title="protected">
<h2>Sets the permissions property.</h2>
<pre>setPermissions() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_setRoles"></a><div class="element clickable method protected method_setRoles" data-toggle="collapse" data-target=".method_setRoles .collapse" title="protected">
<h2>Sets the roles property.</h2>
<pre>setRoles() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<h3>
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_displayParentType"> </a><div class="element clickable property public property_displayParentType" data-toggle="collapse" data-target=".property_displayParentType .collapse" title="public">
<h2>$displayParentType</h2>
<pre>$displayParentType </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>false</code></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>property</th>
<td>whether to show the parent type
in the inherited item tooltip.</td>
</tr></table>
</div></div>
</div>
<a id="property__authorizer"> </a><div class="element clickable property private property__authorizer" data-toggle="collapse" data-target=".property__authorizer .collapse" title="private">
<h2>$_authorizer</h2>
<pre>$_authorizer </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__items"> </a><div class="element clickable property private property__items" data-toggle="collapse" data-target=".property__items .collapse" title="private">
<h2>$_items</h2>
<pre>$_items </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__parents"> </a><div class="element clickable property private property__parents" data-toggle="collapse" data-target=".property__parents .collapse" title="private">
<h2>$_parents</h2>
<pre>$_parents </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__permissions"> </a><div class="element clickable property private property__permissions" data-toggle="collapse" data-target=".property__permissions .collapse" title="private">
<h2>$_permissions</h2>
<pre>$_permissions </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property__roles"> </a><div class="element clickable property private property__roles" data-toggle="collapse" data-target=".property__roles .collapse" title="private">
<h2>$_roles</h2>
<pre>$_roles </pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br>
            generated on 2014-02-03T11:03:56-02:00.<br></footer></div>
</div>
</body>
</html>
